Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Improve FAQ page and RayService troubleshooting guide #1225

Merged
merged 4 commits into from
Jul 10, 2023

Conversation

kevin85421
Copy link
Member

@kevin85421 kevin85421 commented Jul 9, 2023

Why are these changes needed?

Improve FAQ page and RayService troubleshooting guide.

Related issue number

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • This PR is not tested :(

@kevin85421 kevin85421 changed the title [Doc] Improve RayService troubleshooting guide [Doc] Improve doc Jul 10, 2023
@kevin85421 kevin85421 marked this pull request as ready for review July 10, 2023 16:39
Copy link
Contributor

@architkulkarni architkulkarni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, can you please update the PR title and add a brief PR description?

- Design:
- Core API and Backend Service: design/protobuf-grpc-service.md
- Troubleshooting:
- FAQ: guidance/FAQ.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Would it be better to make the FAQ top-level instead of under Troubleshooting? Currently it seems all the questions are troubleshooting-related, but my guess is we'll probably add some non-troubleshooting questions to the FAQ in the future.

@kevin85421 kevin85421 changed the title [Doc] Improve doc [Doc] Improve FAQ page and RayService troubleshooting guide Jul 10, 2023
@kevin85421
Copy link
Member Author

Looks good, can you please update the PR title and add a brief PR description?

Updated. I have just summarized some common issues in this PR. There is nothing special here.

@kevin85421 kevin85421 merged commit c16cac4 into ray-project:master Jul 10, 2023
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
…ect#1225)

Improve FAQ page and RayService troubleshooting guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants